package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.CompanyContractQuotaRecordAddDTO;
import org.jsola.hr.dto.CompanyContractQuotaRecordUpdateDTO;
import org.jsola.hr.query.CompanyContractQuotaRecordQuery;
import org.jsola.hr.vo.CompanyContractQuotaRecordVO;

import java.util.List;

/**
 * 用工单位合同配额明细表
 *
 * @author wcl
 */
@Api(tags = "hr-用工单位合同配额明细表")
public interface ICompanyContractQuotaRecordControllerAPI {

    /**
     * 新增用工单位合同配额明细
     *
     * @param companyContractQuotaRecordAddDTO 用工单位合同配额明细新增实体
     * @return 用工单位合同配额明细展示对象
     */
    @ApiOperation(value = "新增用工单位合同配额明细")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyContractQuotaRecordAddDTO", dataType = "CompanyContractQuotaRecordAddDTO", value = "新增用工单位合同配额明细", paramType = "body")
    })
    Result<CompanyContractQuotaRecordVO> save(CompanyContractQuotaRecordAddDTO companyContractQuotaRecordAddDTO);


    /**
     * 修改用工单位合同配额明细
     *
     * @param companyContractQuotaRecordUpdateDTO 用工单位合同配额明细
     * @return 更新数量
     */
    @ApiOperation(value = "修改用工单位合同配额明细")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyContractQuotaRecordUpdateDTO", dataType = "CompanyContractQuotaUpdateDTO", value = "修改用工单位合同配额明细", paramType = "body")
    })
    Result<Integer> update(CompanyContractQuotaRecordUpdateDTO companyContractQuotaRecordUpdateDTO);

    /**
     * 删除单个用工单位合同配额明细，彻底删除
     *
     * @param companyContractQuotaRecordId 用工单位合同配额明细id
     * @return 删除数量
     */
    @ApiOperation(value = "删除单个用工单位合同配额明细，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyContractQuotaRecordId", dataType = "String", value = "用工单位合同配额明细id", paramType = "path")
    })
    Result<Integer> delete(String companyContractQuotaRecordId);


    /**
     * 批量删除用工单位合同配额明细，彻底删除
     *
     * @param companyContractQuotaRecordIds 用工单位合同配额明细id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除用工单位合同配额明细，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyContractQuotaRecordIds", dataType = "String[]", value = "用工单位合同配额明细id数组", paramType = "body", allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] companyContractQuotaRecordIds);


    /**
     * 根据用工单位合同配额明细id查询用工单位合同配额明细详情
     *
     * @param companyContractQuotaRecordId 用工单位合同配额明细id
     * @return 用工单位合同配额明细详情
     */
    @ApiOperation(value = "根据用工单位合同配额明细id查询用工单位合同配额明细详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyContractQuotaRecordId", dataType = "String", value = "用工单位合同配额明细id", paramType = "path")
    })
    Result<CompanyContractQuotaRecordVO> findById(String companyContractQuotaRecordId);


    /**
     * 查询用工单位合同配额明细
     *
     * @param companyContractQuotaRecordQuery 用工单位合同配额明细查询参数
     * @return page
     */
    @ApiOperation(value = "查询用工单位合同配额明细")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyContractQuotaRecordQuery", dataType = "CompanyContractQuotaRecordQuery", value = "用工单位合同配额明细查询参数", paramType = "query")
    })
    Result<List<CompanyContractQuotaRecordVO>> listAll(CompanyContractQuotaRecordQuery companyContractQuotaRecordQuery);


    /**
     * 分页查询用工单位合同配额明细
     *
     * @param companyContractQuotaRecordQuery 用工单位合同配额明细查询参数
     * @return page
     */
    @ApiOperation(value = "分页查询用工单位合同配额明细")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyContractQuotaRecordQuery", dataType = "CompanyContractQuotaRecordQuery", value = "用工单位合同配额明细查询参数", paramType = "query")
    })
    Result<Page<CompanyContractQuotaRecordVO>> page(CompanyContractQuotaRecordQuery companyContractQuotaRecordQuery);


}

